/*
	This file is part of AVRCppLib.

    AVRCppLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    AVRCppLib is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with AVRCppLib.  If not, see <http://www.gnu.org/licenses/>.

    Copyright (C) Maxime Lemonnier 2007-2011
 */

#ifndef DICTIONARY_H_
#define DICTIONARY_H_

#include "../Utils/CppExtensions.h"
#include "BufferIterator.h"
#include <stdlib.h>

#define DICTIONARY_DEFAULT_SIZE 10
template <class KeyType, class ElementType>
struct Pair
{
	KeyType key;
	ElementType item;
};


template <class KeyType, class ElementType>
class Dictionary {

public :

	typedef BufferIterator<KeyType> KeyIterator;
	typedef BufferIterator<ElementType> ElementIterator;

	static int comparePairs(const void * lhs, const void * rhs);

	Dictionary(size_t capacity = DICTIONARY_DEFAULT_SIZE);

	Dictionary(const Dictionary<KeyType, ElementType>  & copy);

	Dictionary<KeyType, ElementType> & operator=(const Dictionary<KeyType, ElementType>  &  rhs);

	virtual ~Dictionary();


	bool insertElement(KeyType key, ElementType item);

	bool removeElement(KeyType key);

	ElementType * find(KeyType key) const;

	KeyIterator keys() const;

	ElementIterator elements() const;

	bool isFull() const;

	bool isEmpty() const;

	void removeAllElements();

	size_t numberOfElements() const;

private:
	const size_t stepSize;
	size_t capacity;
	Pair<KeyType, ElementType> * memory;
	size_t nextElementIndex;


};

#include "Dictionary-definitions.h"
#endif /* DICTIONARY_H_ */
